Management API
Base Resource URL:
https://sandbox-portal.tidypay.com/api/v01/merchants/[merchant-code]/billing
Description:
Represents billing configuration for the given merchant.
UniBill only
Supported Actions:
configure
Parameters:
| Method: GET | Implicit: No | Returns: ServiceResponse |
| Consumes: xurl | Produces: json, xml | |
|
Executes configuration script(-s) to perform various recurring billing related actions.
|
||
Parameters:
| # | Name | Type | Required | Default | Description |
|---|---|---|---|---|---|
| 01 | profile | String | Yes |
This parameter is used to indicate the file name without its extension. The scripts should be uploaded to the following directory: $app-home\resources\billing-setup\
Here are two examples of actions that the script can perform: api.billingCycle("M"); // create monthly billing cycle codes (from M01 to M31) api.createBillingProfile(); // create default billing and billing profile In this case the full API-call will look like: https://sandbox.unipaygateway.info/api/v01/merchants/2000/billing/~configure?profile=production |
Copyright ©
TidyPay. All Rights Reserved.
All Logos and Trademarks used or mentioned on this page are copyrighted property of their respective owners and are used for display purposes only.